Skip to content

Re-enable webhooks sidebar link in project dashboard #7196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

AmineAfia
Copy link
Contributor

@AmineAfia AmineAfia commented May 29, 2025

[Dashboard] Feature: Add Webhooks to Project Sidebar

Notes for the reviewer

This PR adds the Webhooks option to the project sidebar navigation. The option was previously commented out due to a scrolling issue, which has now been resolved.

How to test

Navigate to a project page and verify that the Webhooks option appears in the sidebar with a "New" badge.


PR-Codex overview

This PR focuses on refining the webhook functionality within the application by updating types, improving API fetch calls with secure URLs, and enhancing the sidebar component to include a Webhooks link.

Detailed summary

  • Updated params type in webhookPayloadUtils.ts from unknown[] to Record<string, unknown>.
  • Changed params initialization from an empty array [] to an empty object {} in buildTransactionWebhookPayload.
  • Added BellIcon and reintroduced the Webhooks link in ProjectSidebarLayout.tsx.
  • Updated fetch calls in webhooks.ts to use secure URLs (https://).
  • Ensured consistent header structure in fetch requests across multiple functions in webhooks.ts.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • New Features

    • Re-enabled the "Webhooks" link in the project sidebar, now visible with a "New" badge.
  • Bug Fixes

    • Improved API reliability by ensuring all webhook-related network requests use the correct HTTPS scheme.
  • Refactor

    • Updated internal data structures for webhook payloads to improve consistency and type safety.

Copy link

changeset-bot bot commented May 29, 2025

⚠️ No Changeset found

Latest commit: cb994dc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented May 29, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 29, 2025 7:38pm
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Skipped (Inspect) May 29, 2025 7:38pm
login ⬜️ Skipped (Inspect) May 29, 2025 7:38pm
thirdweb_playground ⬜️ Skipped (Inspect) May 29, 2025 7:38pm
wallet-ui ⬜️ Skipped (Inspect) May 29, 2025 7:38pm

@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 29, 2025 10:34 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 29, 2025 10:34 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 29, 2025 10:34 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 29, 2025 10:34 Inactive
Copy link
Contributor

coderabbitai bot commented May 29, 2025

Walkthrough

The changes update webhook API calls to explicitly use the HTTPS scheme, re-enable the "Webhooks" sidebar link in the dashboard UI, and refine the type of the params property in webhook payload utilities to enforce stricter typing. No changes are made to function signatures or public entity declarations.

Changes

File(s) Change Summary
apps/dashboard/src/@/api/insight/webhooks.ts Updated all fetch calls to explicitly use https:// in the API domain. Refactored fetch syntax for clarity.
apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/components/ProjectSidebarLayout.tsx Re-enabled and imported the "Webhooks" sidebar link with icon and badge in the project sidebar layout.
apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/webhooks/utils/webhookPayloadUtils.ts Changed params type in WebhookPayload.signatures from `Record<string, unknown>

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DashboardUI
    participant WebhookAPI

    User->>DashboardUI: Clicks "Webhooks" in sidebar
    DashboardUI->>WebhookAPI: fetch('https://<API_DOMAIN>/webhooks', ...)
    WebhookAPI-->>DashboardUI: Returns webhook data
    DashboardUI-->>User: Displays webhooks
Loading

Possibly related PRs

Suggested labels

Portal


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e6a5fc4 and cb994dc.

📒 Files selected for processing (3)
  • apps/dashboard/src/@/api/insight/webhooks.ts (4 hunks)
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/components/ProjectSidebarLayout.tsx (2 hunks)
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/webhooks/utils/webhookPayloadUtils.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • apps/dashboard/src/@/api/insight/webhooks.ts
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/components/ProjectSidebarLayout.tsx
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/webhooks/utils/webhookPayloadUtils.ts
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Unit Tests
  • GitHub Check: E2E Tests (pnpm, esbuild)
  • GitHub Check: Build Packages
  • GitHub Check: E2E Tests (pnpm, webpack)
  • GitHub Check: Size
  • GitHub Check: E2E Tests (pnpm, vite)
  • GitHub Check: Lint Packages
  • GitHub Check: Analyze (javascript)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor Author

AmineAfia commented May 29, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions bot added the Dashboard Involves changes to the Dashboard. label May 29, 2025
Copy link

codecov bot commented May 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.68%. Comparing base (4d38a7e) to head (cb994dc).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7196   +/-   ##
=======================================
  Coverage   55.68%   55.68%           
=======================================
  Files         904      904           
  Lines       58392    58392           
  Branches     4122     4122           
=======================================
  Hits        32516    32516           
  Misses      25770    25770           
  Partials      106      106           
Flag Coverage Δ
packages 55.68% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

github-actions bot commented May 29, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 61.79 KB (0%) 1.3 s (0%) 2.4 s (+8.63% 🔺) 3.6 s
thirdweb (cjs) 344.76 KB (0%) 6.9 s (0%) 15.6 s (-0.33% 🔽) 22.5 s
thirdweb (minimal + tree-shaking) 5.69 KB (0%) 114 ms (0%) 176 ms (+37.89% 🔺) 289 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 66 ms (+29.63% 🔺) 76 ms
thirdweb/react (minimal + tree-shaking) 19.54 KB (0%) 391 ms (0%) 352 ms (-31.1% 🔽) 743 ms

@AmineAfia AmineAfia force-pushed the Re-enable_webhooks_sidebar_link_in_project_dashboard branch from 467d4bf to f3aebed Compare May 29, 2025 13:19
@AmineAfia AmineAfia force-pushed the Re-enable_webhooks_sidebar_link_in_project_dashboard branch from f3aebed to a58e480 Compare May 29, 2025 19:09
@AmineAfia AmineAfia force-pushed the Re-enable_webhooks_sidebar_link_in_project_dashboard branch from a58e480 to e6a5fc4 Compare May 29, 2025 19:21
@AmineAfia AmineAfia marked this pull request as ready for review May 29, 2025 19:22
@AmineAfia AmineAfia requested review from a team as code owners May 29, 2025 19:22
Copy link
Contributor

graphite-app bot commented May 29, 2025

Merge activity

## [Dashboard] Feature: Add Webhooks to Project Sidebar

## Notes for the reviewer

This PR adds the Webhooks option to the project sidebar navigation. The option was previously commented out due to a scrolling issue, which has now been resolved.

## How to test

Navigate to a project page and verify that the Webhooks option appears in the sidebar with a "New" badge.

<!-- start pr-codex -->

---

## PR-Codex overview
This PR primarily focuses on refining the handling of webhook payloads and enhancing the `ProjectSidebarLayout` component by reintroducing the webhooks link. It also updates the API fetch calls to ensure they consistently use HTTPS.

### Detailed summary
- Changed `params` type in `webhookPayloadUtils.ts` from `Record<string, unknown> | unknown[]` to `Record<string, unknown>`.
- Updated `params` in the `buildTransactionWebhookPayload` function to use an empty object instead of an empty array.
- Reintroduced the webhooks link in `ProjectSidebarLayout.tsx` with appropriate properties.
- Updated fetch calls in `webhooks.ts` to use HTTPS for the API domain in multiple functions (`getWebhooks`, `deleteWebhook`, `testWebhook`).

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

<!-- end pr-codex -->

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

- **New Features**
  - Re-enabled the "Webhooks" link in the project sidebar, now visible with a "New" badge.

- **Bug Fixes**
  - Improved API reliability by ensuring all webhook-related network requests use the correct HTTPS scheme.

- **Refactor**
  - Updated internal data structures for webhook payloads to improve consistency and type safety.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@graphite-app graphite-app bot force-pushed the Re-enable_webhooks_sidebar_link_in_project_dashboard branch from e6a5fc4 to cb994dc Compare May 29, 2025 19:31
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 29, 2025 19:31 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 29, 2025 19:31 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 29, 2025 19:31 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 29, 2025 19:31 Inactive
@graphite-app graphite-app bot merged commit cb994dc into main May 29, 2025
24 checks passed
@graphite-app graphite-app bot deleted the Re-enable_webhooks_sidebar_link_in_project_dashboard branch May 29, 2025 19:39
@vercel vercel bot temporarily deployed to Production – wallet-ui May 29, 2025 19:39 Inactive
@vercel vercel bot temporarily deployed to Production – thirdweb_playground May 29, 2025 19:39 Inactive
@vercel vercel bot temporarily deployed to Production – login May 29, 2025 19:39 Inactive
@vercel vercel bot temporarily deployed to Production – docs-v2 May 29, 2025 19:39 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dashboard Involves changes to the Dashboard.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants